Generate Sphinx Documentation and document how to build it.#170
Merged
bernhardkaindl merged 3 commits intoxenserver:masterfrom Aug 28, 2025
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #170 +/- ##
======================================
Coverage 83.3% 83.3%
======================================
Files 23 23
Lines 3347 3347
======================================
Hits 2790 2790
Misses 557 557
|
Pull Request Test Coverage Report for Build 17274001479Details
💛 - Coveralls |
bernhardkaindl
force-pushed
the
deply-docs-using-gh-action-to-pages
branch
2 times, most recently
from
b867404 to
b2d41c9
Compare
bernhardkaindl
force-pushed
the
deply-docs-using-gh-action-to-pages
branch
2 times, most recently
from
8143779 to
999d1aa
Compare
bernhardkaindl
changed the title
bernhardkaindl
force-pushed
the
deply-docs-using-gh-action-to-pages
branch
from
999d1aa to
7df3ffa
Compare
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
bernhardkaindl
force-pushed
the
deply-docs-using-gh-action-to-pages
branch
from
7df3ffa to
2eae0b7
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive Sphinx documentation generation to the python-libs project, enabling automatic API documentation and documentation hosting on platforms like ReadTheDocs. The documentation uses Google-style docstrings and includes both project documentation and auto-generated module references.
- Configures Sphinx with autodoc, MyST parser, and Furo theme for modern documentation
- Updates existing docstrings to use consistent backtick formatting instead of single quotes
- Creates individual RST files for each XCP module with auto-documentation directives
Reviewed Changes
Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/source/conf.py | Main Sphinx configuration with autodoc and MyST parser setup |
| docs/source/index.rst | Documentation homepage with project structure and module listing |
| docs/source/*.rst | Individual module documentation files for auto-generated API docs |
| docs/requirements.txt | Sphinx dependencies including furo theme and myst_parser |
| docs/Makefile | Standard Sphinx makefile for building documentation |
| .readthedocs.yml | ReadTheDocs configuration for automated documentation hosting |
| xcp/cpiofile.py | Updated docstrings to use backticks instead of single quotes |
| xcp/accessor.py | Improved docstring formatting with proper code block syntax |
| README.md | Fixed markdown syntax and code block language tags |
| DOCUMENTING.md | New documentation guide explaining Google-style docstrings and Sphinx usage |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
GeraldEV
approved these changes
Aug 28, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Generate Sphinx Documentation and document how to build it.
The docs/static can be opened directly in a web browser, any static site and also readthedocs.io (config included).
Sample Preview URLs:
For further spelling fixes, please review #171 (for
CONTRIBUTING.md), and the other non-draft PRs.Merging the cleanup PRs is a precondition for making spelling fixes (those would cause conflicts otherwise).